Apple DocViewer™• Read Me •Version 1.1.1What is the Apple DocViewer?Apple DocViewer is an on-line documentation application. It provides a standard way for Apple to distribute documentation to developers in an electronic form.Apple DocViewer provides a quick on-screen reference for browsing through multiple documents. It supports full Macintosh mixed-text and graphics, printing, interactive table of contents/catalog, book indexes, text search & retrieval, the ability to copy text and/or pictures for use in other applications, and provides the ability to set bookmarks to commonly used pages in documentation. With our new Collections feature, users can create their own “virtual books” from whole or parts of other books.Version 1.1.1 Release NotesSince the release of version 1.1, we received quite a bit of feedback from our users. The following list outlines the minor changes in Version 1.1.1:• "The Preference is Yours" - We have restored the application preferences to allow you to specify a default view style and scaling when you open DocViewer documents.• DocViewer Lookup Apple event support - Support has been added so that DocViewer can now be messaged via Apple events. Please see the DocViewer Tech Note "Apple Event Support in DocViewer 1.1.1" included with this version on the Developer CD series.Enhancements and Minor Bug fixes (From version 1.1) • Running UniFinder on System 6.0.5 on a Macintosh SE, the Apple DocViewer crashes when the Control Panel is accessed. - This problem has been resolved. If the memory situation is bad, you will not be able to access the Control Panel desk accessory. • There is now support for 8-bit languages and character sets. Previous versions had trouble searching for high-ASCII characters. • Garbage characters in the Query dialog with “Show Context” selected in low memory situations. - This problem has been resolved. • Many annoying dialogs in low-memory situations. - This problem has been resolved. • Problems clicking on the “Splash Screen” during launch caused a crash on some Macs. - This problem has been resolved. • Problems with the use of the “Shift” key while selecting “Next Occurrence” have been resolved. • Printing from the Finder is now supported! (Yeah!) • Many other minor bugs were addressed and fixed. • Preferences information - Previously, the DocViewer stored user preferences that determined user view, and zooming. This information is now stored in the document when possible.There are some minor bugs and enhancements which are not addressed in Version 1.1. These and user tips are documented in later pages of this Read Me file. If you have comments or suggestions we would like to hear from you via AppleLink to DEV.CD. We will not be answering individual questions about this software, but this information will be forwarded to the engineering group.InstallationApple DocViewer runs on all models of the Macintosh® computer from the Macintosh Plus onward. It runs under versions 6.0.5 and later of the Macintosh system software, including version 7.0, Release 7.1. Apple DocViewer requires at least 1024 Kb memory partition.Apple DocViewer also requires both bitmap and TrueType fonts. In particular, many Apple DocViewer documents use Palatino, Helvetica, Courier, and Zapf Dingbats. We are providing these fonts in the Apple DocViewer Fonts folder. The Apple DocViewer application can be run directly off a CD, or from a server, but we strongly recommend that you copy the application to your local hard drive.LimitationsApple DocViewer is NOT a word processor—it was designed to support quick conversion of existing technical documents to electronic form. Apple DocViewer focuses on being both a printing and display tool. Printing is limited by Apple DocViewer’s display capabilities and displaying is limited by Apple DocViewer’s print capabilities. In particular:- Display spacing may appear uneven on some documents because the text is kerned for printing, not display.- Output on non-postscript printers may be less satisfactory.- Color/Gray Scale must be selected for printing color/shaded figures.- Documents may be more difficult to read on systems which do not have a complete set of screen fonts or do not have TrueType installed.This version of Apple DocViewer has a number of features that are incomplete, notably:- The “Text Only” view is only partially implemented. Text still needs to continuously flow between page boundaries for true dynamic text reformatting capabilities.Recommendations, Tips, and Techniques• It is not required, but use both bitmap and TrueType fonts for the best display quality . If you are running under System 6, please use the TrueType INIT in the TrueType Fonts & Software folder.• To improve display legibility on monitors larger than 13'' (that typically have a resolution greater then 72 dpi) set SCALING to 112% in the document window. We've found this to be a good compromise between window size and font size.• Apple DocViewer has been optimized for displaying documents off of a CD-ROM. However, copying the document file you use most (and its associated index file) to your local hard disk can significantly improve performance.• The “Query” command uses an efficient indexing technique with Apple DocViewer documents, however, it does not index every word. Words such as (and, but, or, because, etc.) and words less than 4 characters in length are not indexed. The “Find” command uses a search method that is much slower, but will find every word in a document. The “Table of Contents” window’s “Filter” narrows the list of table of contents entries. The “Open Book Index” displays an index created by the authors of the document. Explore the difference between these four features and use the one most appropriate for your task.• Apple DocViewer is optimized for printing on Postscript printers, such as the Apple LaserWriter. New Inside Macintosh documents take advantage of the “Larger Print Area” option available from the LaserWriter’s Page Setup/Options dialogue. Printing with other printers will work, but there may be clipped pages, or reduced print quality.• Users in countries which use A4 paper may print Apple DocViewer documents by using the “Reduce or Enlarge” setting of the “Page Setup” dialog.• Use Apple DocViewer’s “Copy” command to get code samples and paste them into your source. This code can them be compiled or incorporated into your software. Remember, there is no copyright limitation on use of source code from Apple documentation.• Technical writers developing in-house documentation can use Apple DocViewer’s “Copy” capability to grab figures or text from Apple documentation for internal documentation or in-house training. Unlike source code, however, documentation or courses developed for sale to your customers MAY NOT incorporate figures or text from Apple documentation.• We have tried to optimize the usability of Apple DocViewer on small screens. If you have a small screen, we recommend you use the “Text Only” view of Apple DocViewer, and adjust the window size to your liking. Then use the page up/down arrow icons to navigate individual pages in the document.Known Problems• Problem: When printing New Inside Macintosh documents, the top and bottom edges of the page can be cut off. Solution: Set the “Larger Print Area” option available from the LaserWriter’s “Page Setup/Options” dialogue. • Problem: When running the application from a server, if that server disconnects while DocViewer is running, the application will begin beeping incessantly. Solution: Do not run Apple DocViewer off of a server.• Problem: The “From” and “To” fields in the “Print” dialog box do not accept the “Chapter-Page” form of page numbers (e.g., From 1-3 to 3-3). Solution: Use the physical page numbers displayed inside the parentheses in the “Page Indicator” area of the document window. Lower portion of the Print Dialog will display the actual page numbers displayed on the document.• Problem: “Query ‘Within n words of…’” does not count the number of words correctly, given an integer value for n. Solution: Add 2 to 3 for the value n.• Problem: When you use “Query”, Apple DocViewer displays the message “The index file for <<docname>> cannot be found.” Solution: Be sure the Apple DocViewer document and its associated “.idx” file are in the same folder• Problem: Some “Query” searches do not find text that includes punctuation or hyphens in either the search string or the text being searched. Solution: There is a bug in the “Query” command such that punctuation characters are not passed to the search engine. For example, the search string “get file” will not find the text “get, file” – the fix (for now) is to search for “get x file”. The “x” serves as a noise word that is ignored, but broadens the search. Searching “get x file” will find “get file”, “get, file”, “get on file”, “get the file”, etc.T h@ ˇ ˇˇˇˇ @ h
h@ , Geneva . ° d ONLN dˇˇ +¬HApple DocViewer™ ° d ONLN dˇˇ +(• Read Me • ° d ONLN dˇˇ +Version 1.1.1 ° d ONLN dˇˇ ( í 6 What is the Apple DocViewer?
° d ONLN dˇˇ *Apple DocViewer ° d ONLN dˇˇ )QN is an on-line documentation application. It provides a standard way for Apple ° d ONLN dˇˇ ( ¨ 6@to distribute documentation to developers in an electronic form. ° d ONLN dˇˇ *Apple DocViewer ° d ONLN dˇˇ )QC provides a quick on-screen reference for browsing through multiple ° d ONLN dˇˇ ( – 6]documents. It supports full Macintosh mixed-text and graphics, printing, interactive table of ° d ONLN dˇˇ * acontents/catalog, book indexes, text search & retrieval, the ability to copy text and/or pictures ° d ONLN dˇˇ * _for use in other applications, and provides the ability to set bookmarks to commonly used pages ° d ONLN dˇˇ * in documentation. With our new ° d ONLN dˇˇ )† Collections ° d ONLN dˇˇ )5- feature, users can create their own “virtual ° d ONLN dˇˇ ( 6*books” from whole or parts of other books. +®B Apple DocViewer v1.1.1 Read Me (BPage )1 ˇ¬ h@ ˇ ˇˇˇˇ @ h
° d ONLN dˇˇ *ZSince the release of version 1.1, we received quite a bit of feedback from our users. The ° d ONLN dˇˇ * ;following list outlines the minor changes in Version 1.1.1: ° d ONLN dˇˇ *[• "The Preference is Yours" - We have restored the application preferences to allow you to ° d ONLN dˇˇ * Kspecify a default view style and scaling when you open DocViewer documents. ° d ONLN dˇˇ *\• DocViewer Lookup Apple event support - Support has been added so that DocViewer can now be ° d ONLN dˇˇ * Vmessaged via Apple events. Please see the DocViewer Tech Note "Apple Event Support in ° d ONLN dˇˇ * GDocViewer 1.1.1" included with this version on the Developer CD series. +®ê Apple DocViewer v1.1.1 Read Me (BPage )2 ˇF h@ ˇ ˇˇˇˇ @ h
h@ , Geneva . ° d ONLN dˇˇ +6B3Enhancements and Minor Bug fixes (From version 1.1)
° d ONLN dˇˇ +C!;• Running UniFinder on System 6.0.5 on a Macintosh SE, the ° d ONLN dˇˇ ( c¢Apple DocViewer ° d ONLN dˇˇ ( o y+crashes when the Control Panel is accessed. ° d ONLN dˇˇ *R- This problem has been resolved. If the memory situation is bad, you will not be ° d ONLN dˇˇ * 0able to access the Control Panel desk accessory. ° d ONLN dˇˇ *Q• There is now support for 8-bit languages and character sets. Previous versions ° d ONLN dˇˇ * 0had trouble searching for high-ASCII characters. ° d ONLN dˇˇ *L• Garbage characters in the Query dialog with “Show Context” selected in low ° d ONLN dˇˇ * memory situations. ° d ONLN dˇˇ * !- This problem has been resolved. ° d ONLN dˇˇ *1• Many annoying dialogs in low-memory situations. ° d ONLN dˇˇ * !- This problem has been resolved. ° d ONLN dˇˇ *O• Problems clicking on the “Splash Screen” during launch caused a crash on some ° d ONLN dˇˇ * Macs. ° d ONLN dˇˇ * !- This problem has been resolved. +e Apple DocViewer v1.1.1 Read Me (BPage )3 ˇ¬ h@ ˇ ˇˇˇˇ @ h
h@ , Geneva
. ° d ONLN dˇˇ +y@L• Problems with the use of the “Shift” key while selecting “Next Occurrence” ° d ONLN dˇˇ * have been resolved. ° d ONLN dˇˇ * 4• Printing from the Finder is now supported! (Yeah!) ° d ONLN dˇˇ *2• Many other minor bugs were addressed and fixed. ° d ONLN dˇˇ *M• Preferences information - Previously, the DocViewer stored user preferences ° d ONLN dˇˇ * Nthat determined user view, and zooming. This information is now stored in the ° d ONLN dˇˇ * document when possible. ° d ONLN dˇˇ ( ∏ 6]There are some minor bugs and enhancements which are not addressed in Version 1.1. These and ° d ONLN dˇˇ * Vuser tips are documented in later pages of this Read Me file. If you have comments or ° d ONLN dˇˇ * \suggestions we would like to hear from you via AppleLink to DEV.CD. We will not be answering ° d ONLN dˇˇ * Windividual questions about this software, but this information will be forwarded to the ° d ONLN dˇˇ * engineering group. +®Z Apple DocViewer v1.1.1 Read Me (BPage )4 ˇ& h@ ˇ ˇˇˇˇ @ h
h@ , Geneva . ° d ONLN dˇˇ +6D Installation
° d ONLN dˇˇ *Apple DocViewer ° d ONLN dˇˇ )QF runs on all models of the Macintosh® computer from the Macintosh Plus ° d ONLN dˇˇ ( ^ 6Zonward. It runs under versions 6.0.5 and later of the Macintosh system software, including ° d ONLN dˇˇ * version 7.0, Release 7.1. ° d ONLN dˇˇ )~Apple DocViewer ° d ONLN dˇˇ )Q, requires at least 1024 Kb memory partition. ° d ONLN dˇˇ ( Ç 6Apple DocViewer ° d ONLN dˇˇ )QI also requires both bitmap and TrueType fonts. In particular, many Apple ° d ONLN dˇˇ ( é 6YDocViewer documents use Palatino, Helvetica, Courier, and Zapf Dingbats. We are providing ° d ONLN dˇˇ * these fonts in the ° d ONLN dˇˇ )VApple DocViewer ° d ONLN dˇˇ )Q Fonts folder. ° d ONLN dˇˇ ( ≤ 6The ° d ONLN dˇˇ )Apple DocViewer ° d ONLN dˇˇ )QL application can be run directly off a CD, or from a server, but we strongly ° d ONLN dˇˇ ( æ 6Arecommend that you copy the application to your local hard drive. +®Ñ Apple DocViewer v1.1.1 Read Me (BPage )5 ˇò h@ ˇ ˇˇˇˇ @ h
h@ , Geneva . ° d ONLN dˇˇ +6D Limitations
° d ONLN dˇˇ *Apple DocViewer ° d ONLN dˇˇ )QG is NOT a word processor—it was designed to support quick conversion of ° d ONLN dˇˇ ( ^ 61existing technical documents to electronic form. ° d ONLN dˇˇ )ÏApple DocViewer ° d ONLN dˇˇ )Q focuses on being both a ° d ONLN dˇˇ ( j 62printing and display tool. Printing is limited by ° d ONLN dˇˇ )ÎApple DocViewer ° d ONLN dˇˇ )Q’s display capabilities and ° d ONLN dˇˇ ( v 6displaying is limited by ° d ONLN dˇˇ )vApple DocViewer ° d ONLN dˇˇ )Q%’s print capabilities. In particular: ° d ONLN dˇˇ ( á H- ° d ONLN dˇˇ )RDisplay spacing may appear uneven on some documents because the text is kerned for ° d ONLN dˇˇ * printing, not display. ° d ONLN dˇˇ ( § H- ° d ONLN dˇˇ );Output on non-postscript printers may be less satisfactory. ° d ONLN dˇˇ ( µ H- ° d ONLN dˇˇ )DColor/Gray Scale must be selected for printing color/shaded figures. ° d ONLN dˇˇ ( Δ H- ° d ONLN dˇˇ )VDocuments may be more difficult to read on systems which do not have a complete set of ° d ONLN dˇˇ * /screen fonts or do not have TrueType installed. ° d ONLN dˇˇ ( ‚ 6VThis version of Apple DocViewer has a number of features that are incomplete, notably: ° d ONLN dˇˇ +- ° d ONLN dˇˇ )UThe “Text Only” view is only partially implemented. Text still needs to continuously ° d ONLN dˇˇ * Mflow between page boundaries for true dynamic text reformatting capabilities. ° d ONLN dˇˇ ( 6%Recommendations, Tips, and Techniques +≠. Apple DocViewer v1.1 Read Me (BPage )6 ˇ p h@ ˇ ˇˇˇˇ @ h
h@ , Geneva
. ° d ONLN dˇˇ +6@• ° d ONLN dˇˇ )`It is not required, but use both bitmap and TrueType fonts for the best display quality . If you ° d ONLN dˇˇ * @are running under System 6, please use the TrueType INIT in the ° d ONLN dˇˇ ( LÅTrueType Fonts & Software ° d ONLN dˇˇ ( X Cfolder. ° d ONLN dˇˇ ( i 6• ° d ONLN dˇˇ )\To improve display legibility on monitors larger than 13'' (that typically have a resolution ° d ONLN dˇˇ * Ygreater then 72 dpi) set SCALING to 112% in the document window. We've found this to be a ° d ONLN dˇˇ * 2good compromise between window size and font size. ° d ONLN dˇˇ ( í 6• ° d ONLN dˇˇ )Apple DocViewer ° d ONLN dˇˇ )QG has been optimized for displaying documents off of a CD-ROM. However, ° d ONLN dˇˇ ( û C^copying the document file you use most (and its associated index file) to your local hard disk ° d ONLN dˇˇ * &can significantly improve performance. ° d ONLN dˇˇ ( ª 6• ° d ONLN dˇˇ )>The “Query” command uses an efficient indexing technique with ° d ONLN dˇˇ ( ª|Apple DocViewer ° d ONLN dˇˇ )Q documents, ° d ONLN dˇˇ ( « C\however, it does not index every word. Words such as (and, but, or, because, etc.) and words ° d ONLN dˇˇ * Zless than 4 characters in length are not indexed. The “Find” command uses a search method ° d ONLN dˇˇ * Tthat is much slower, but will find every word in a document. The “Table of Contents” ° d ONLN dˇˇ * Vwindow’s “Filter” narrows the list of table of contents entries. The “Open Book Index” ° d ONLN dˇˇ * Xdisplays an index created by the authors of the document. Explore the difference between ° d ONLN dˇˇ * Cthese four features and use the one most appropriate for your task. ° d ONLN dˇˇ ( 6• ° d ONLN dˇˇ )Apple DocViewer ° d ONLN dˇˇ )QD is optimized for printing on Postscript printers, such as the Apple ° d ONLN dˇˇ ( CLaserWriter. ° d ONLN dˇˇ )DNew Inside Macintosh ° d ONLN dˇˇ )h5 documents take advantage of the “Larger Print Area” (B „ Apple DocViewer v1.1 Read Me (BPage )7 ˇP h@ ˇ ˇˇˇˇ @ h
h@ , Geneva
. ° d ONLN dˇˇ +C@Xoption available from the LaserWriter’s Page Setup/Options dialogue. Printing with other ° d ONLN dˇˇ * Mprinters will work, but there may be clipped pages, or reduced print quality. ° d ONLN dˇˇ ( ] 6• ° d ONLN dˇˇ )0Users in countries which use A4 paper may print ° d ONLN dˇˇ )ÛApple DocViewer ° d ONLN dˇˇ )Q documents by using the ° d ONLN dˇˇ ( i C7“Reduce or Enlarge” setting of the “Page Setup” dialog. ° d ONLN dˇˇ ( z 6• ° d ONLN dˇˇ )Use ° d ONLN dˇˇ )Apple DocViewer ° d ONLN dˇˇ )QF’s “Copy” command to get code samples and paste them into your source. ° d ONLN dˇˇ ( Ü CXThis code can them be compiled or incorporated into your software. Remember, there is no ° d ONLN dˇˇ * Dcopyright limitation on use of source code from Apple documentation. ° d ONLN dˇˇ ( £ 6• ° d ONLN dˇˇ )<Technical writers developing in-house documentation can use ° d ONLN dˇˇ ( £pApple DocViewer ° d ONLN dˇˇ )Q ’s “Copy” ° d ONLN dˇˇ ( Ø CYcapability to grab figures or text from Apple documentation for internal documentation or ° d ONLN dˇˇ * [in-house training. Unlike source code, however, documentation or courses developed for sale ° d ONLN dˇˇ * Oto your customers MAY NOT incorporate figures or text from Apple documentation. +†{ Apple DocViewer v1.1 Read Me (BPage )8 ˇ\ h@ ˇ ˇˇˇˇ @ h
h@ , Geneva
. ° d ONLN dˇˇ +6E• ° d ONLN dˇˇ )+We have tried to optimize the usability of ° d ONLN dˇˇ )ÃApple DocViewer ° d ONLN dˇˇ )Q on small screens. If you have a ° d ONLN dˇˇ ( Q C;small screen, we recommend you use the “Text Only” view of ° d ONLN dˇˇ ( QpApple DocViewer ° d ONLN dˇˇ )Q , and adjust ° d ONLN dˇˇ ( ] C\the window size to your liking. Then use the page up/down arrow icons to navigate individual ° d ONLN dˇˇ * pages in the document. ° d ONLN dˇˇ ( Å 6Known Problems
° d ONLN dˇˇ *• ° d ONLN dˇˇ )Problem ° d ONLN dˇˇ )*: ° d ONLN dˇˇ ) When printing ° d ONLN dˇˇ )JNew Inside Macintosh ° d ONLN dˇˇ )h+ documents, the top and bottom edges of the ° d ONLN dˇˇ ( ú ypage can be cut off. ° d ONLN dˇˇ ( ® C Solution: ° d ONLN dˇˇ )6ISet the “Larger Print Area” option available from the LaserWriter’s “Page ° d ONLN dˇˇ * Setup/Options” dialogue. ° d ONLN dˇˇ ( » 6• ° d ONLN dˇˇ )Problem: ° d ONLN dˇˇ )6LWhen running the application from a server, if that server disconnects while ° d ONLN dˇˇ * EDocViewer is running, the application will begin beeping incessantly. ° d ONLN dˇˇ ( ‡ C Solution: ° d ONLN dˇˇ )6+Do not run Apple DocViewer off of a server. +jb Apple DocViewer v1.1 Read Me (BPage )9 ˇ ¬ h@ ˇ ˇˇˇˇ @ h
h@ , Geneva
. ° d ONLN dˇˇ +6@• ° d ONLN dˇˇ )Problem ° d ONLN dˇˇ )*: ° d ONLN dˇˇ ) FThe “From” and “To” fields in the “Print” dialog box do not accept the ° d ONLN dˇˇ *<“Chapter-Page” form of page numbers (e.g., From 1-3 to 3-3). ° d ONLN dˇˇ ( Y C Solution: ° d ONLN dˇˇ )6KUse the physical page numbers displayed inside the parentheses in the “Page ° d ONLN dˇˇ * OIndicator” area of the document window. Lower portion of the Print Dialog will ° d ONLN dˇˇ * :display the actual page numbers displayed on the document. ° d ONLN dˇˇ ( Ö 6• ° d ONLN dˇˇ )Problem ° d ONLN dˇˇ )*: ° d ONLN dˇˇ ) “Query ‘Within ° d ONLN dˇˇ )Pn ° d ONLN dˇˇ ): words of…’” does not count the number of words correctly, ° d ONLN dˇˇ ( í ygiven an integer value for ° d ONLN dˇˇ )Än ° d ONLN dˇˇ ). ° d ONLN dˇˇ ( û C Solution: ° d ONLN dˇˇ )6Add 2 to 3 for the value ° d ONLN dˇˇ )tn ° d ONLN dˇˇ ). ° d ONLN dˇˇ ( ≤ 6• ° d ONLN dˇˇ )Problem ° d ONLN dˇˇ )*: ° d ONLN dˇˇ ) When you use “Query”, ° d ONLN dˇˇ )wApple DocViewer ° d ONLN dˇˇ )Q) displays the message “The index file for ° d ONLN dˇˇ ( ø y <<docname>> cannot be found.” ° d ONLN dˇˇ ( À C Solution: ° d ONLN dˇˇ )6 Be sure the ° d ONLN dˇˇ ):Apple DocViewer ° d ONLN dˇˇ )Q3 document and its associated “.idx” file are in the ° d ONLN dˇˇ ( ◊ y same folder ° d ONLN dˇˇ ( Î 6• ° d ONLN dˇˇ )Problem ° d ONLN dˇˇ )*: ° d ONLN dˇˇ ) NSome “Query” searches do not find text that includes punctuation or hyphens in ° d ONLN dˇˇ *4either the search string or the text being searched. ° d ONLN dˇˇ ( C Solution: ° d ONLN dˇˇ )6NThere is a bug in the “Query” command such that punctuation characters are not ° d ONLN dˇˇ * Tpassed to the search engine. For example, the search string “get file” will not find ° d ONLN dˇˇ * Othe text “get, file” – the fix (for now) is to search for “get x file”. The “x” +j& Apple DocViewer v1.1 Read Me (B¸Page )10 ˇb h@ ˇ ˇˇˇˇ @ h
h@ , Geneva
. ° d ONLN dˇˇ +y@Qserves as a noise word that is ignored, but broadens the search. Searching “get x ° d ONLN dˇˇ * Lfile” will find “get file”, “get, file”, “get on file”, “get the file”, etc. +jˆ Apple DocViewer v1.1 Read Me (B¸Page )11 ˇ
